home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / CIncludes / OCE.h < prev    next >
C/C++ Source or Header  |  1996-05-01  |  55KB  |  1,404 lines
  1. /*
  2.      File:        OCE.h
  3.  
  4.      Contains:    Apple Open Collaboration Environment (AOCE) Interfaces.
  5.  
  6.      Version:    Technology:    AOCE Toolbox 1.02
  7.                  Release:    Universal Interfaces 3.0d3 on Copland DR1
  8.  
  9.      Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10.  
  11.      Bugs?:        If you find a problem with this file, send the file and version
  12.                  information (from above) and the problem description to:
  13.  
  14.                      Internet:    apple.bugs@applelink.apple.com
  15.                      AppleLink:    APPLE.BUGS
  16.  
  17. */
  18. #ifndef __OCE__
  19. #define __OCE__
  20.  
  21. #ifndef REZ
  22. #ifndef __TYPES__
  23. #include <Types.h>
  24. #endif
  25. #ifndef __ALIASES__
  26. #include <Aliases.h>
  27. #endif
  28. #ifndef __APPLEEVENTS__
  29. #include <AppleEvents.h>
  30. #endif
  31.  
  32. #ifdef __cplusplus
  33. extern "C" {
  34. #endif
  35.  
  36. #if PRAGMA_IMPORT_SUPPORTED
  37. #pragma import on
  38. #endif
  39.  
  40. #if PRAGMA_ALIGN_SUPPORTED
  41. #pragma options align=mac68k
  42. #endif
  43.  
  44. #if FOR_SYSTEM7_ONLY
  45. /* All utility routines defined here are callable at interrupt level. */
  46. typedef unsigned short OCERecordTypeIndex;
  47. typedef unsigned short OCEAttributeTypeIndex;
  48. /*
  49.  For anyone who absolutely needs a define of the body of the standard record or
  50. attribute type, use these below.  CAUTION!  All the types below are assumed to be
  51. in character set 'smRoman'.  If you try to compare these to some RString or
  52. AttributeType variable, you must take the character set code into account.  Future
  53. standard types may be defined using character sets other than 'smRoman'. 
  54. */
  55. /*
  56.  All these standard definitions begin with the Apple symbol (not shown here).
  57.  
  58. NOTE:  To access these, you must call OCEGetIndRecordType or OCEGetIndAttributeType
  59. with the proper index.  These routines return pointers to the standard type.
  60. This was done so that code fragments (INITs, CDEVs, CSAMs, etc). which cannot
  61. use global data can also use these. 
  62. */
  63. /* Indices for the standard definitions for certain record types (OCERecordTypeIndex): */
  64.  
  65. enum {
  66.     kUserRecTypeNum                = 1,                            /* "User" */
  67.     kGroupRecTypeNum            = 2,                            /* "Group" */
  68.     kMnMRecTypeNum                = 3,                            /* "AppleMail[tm] M&M" */
  69.     kMnMForwarderRecTypeNum        = 4,                            /* "AppleMail[tm] Fwdr" */
  70.     kNetworkSpecRecTypeNum        = 5,                            /* "NetworkSpec" */
  71.     kADAPServerRecTypeNum        = 6,                            /* "ADAP Server" */
  72.     kADAPDNodeRecTypeNum        = 7,                            /* "ADAP DNode" */
  73.     kADAPDNodeRepRecTypeNum        = 8,                            /* "ADAP DNode Rep" */
  74.     kServerSetupRecTypeNum        = 9,                            /* "Server Setup" */
  75.     kDirectoryRecTypeNum        = 10,                            /* "Directory" */
  76.     kDNodeRecTypeNum            = 11,                            /* "DNode" */
  77.     kSetupRecTypeNum            = 12,                            /* "Setup" */
  78.     kMSAMRecTypeNum                = 13,                            /* "MSAM" */
  79.     kDSAMRecTypeNum                = 14,                            /* "DSAM" */
  80.     kAttributeValueRecTypeNum    = 15,                            /* "Attribute Value" */
  81.     kBusinessCardRecTypeNum        = 16,                            /* "Business Card" */
  82.     kMailServiceRecTypeNum        = 17,                            /* "Mail Service" */
  83.     kCombinedRecTypeNum            = 18,                            /* "Combined" */
  84.     kOtherServiceRecTypeNum        = 19,                            /* "Other Service" */
  85.     kAFPServiceRecTypeNum        = 20,                            /* "Other Service afps" */
  86.     kFirstOCERecTypeNum            = kUserRecTypeNum,                /* first standard OCE record type */
  87.     kLastOCERecTypeNum            = kAFPServiceRecTypeNum,        /* last standard OCE record type */
  88.     kNumOCERecTypes                = (kLastOCERecTypeNum - kFirstOCERecTypeNum + 1)
  89. };
  90.  
  91. /* Indices for the standard definitions for certain attribute types (OCEAttributeTypeIndex): */
  92.  
  93. enum {
  94.     kMemberAttrTypeNum            = 1001,                            /* "Member" */
  95.     kAdminsAttrTypeNum            = 1002,                            /* "Administrators" */
  96.     kMailSlotsAttrTypeNum        = 1003,                            /* "mailslots" */
  97.     kPrefMailAttrTypeNum        = 1004,                            /* "pref mailslot" */
  98.     kAddressAttrTypeNum            = 1005,                            /* "Address" */
  99.     kPictureAttrTypeNum            = 1006,                            /* "Picture" */
  100.     kAuthKeyAttrTypeNum            = 1007,                            /* "auth key" */
  101.     kTelephoneAttrTypeNum        = 1008,                            /* "Telephone" */
  102.     kNBPNameAttrTypeNum            = 1009,                            /* "NBP Name" */
  103.     kQMappingAttrTypeNum        = 1010,                            /* "ForwarderQMap" */
  104.     kDialupSlotAttrTypeNum        = 1011,                            /* "DialupSlotInfo" */
  105.     kHomeNetAttrTypeNum            = 1012,                            /* "Home Internet" */
  106.     kCoResAttrTypeNum            = 1013,                            /* "Co-resident M&M" */
  107.     kFwdrLocalAttrTypeNum        = 1014,                            /* "FwdrLocalRecord" */
  108.     kConnectAttrTypeNum            = 1015,                            /* "Connected To" */
  109.     kForeignAttrTypeNum            = 1016,                            /* "Foreign RLIs" */
  110.     kOwnersAttrTypeNum            = 1017,                            /* "Owners" */
  111.     kReadListAttrTypeNum        = 1018,                            /* "ReadList" */
  112.     kWriteListAttrTypeNum        = 1019,                            /* "WriteList" */
  113.     kDescriptorAttrTypeNum        = 1020,                            /* "Descriptor" */
  114.     kCertificateAttrTypeNum        = 1021,                            /* "Certificate" */
  115.     kMsgQsAttrTypeNum            = 1022,                            /* "MessageQs" */
  116.     kPrefMsgQAttrTypeNum        = 1023,                            /* "PrefMessageQ" */
  117.     kMasterPFAttrTypeNum        = 1024,                            /* "MasterPF" */
  118.     kMasterNetSpecAttrTypeNum    = 1025,                            /* "MasterNetSpec" */
  119.     kServersOfAttrTypeNum        = 1026,                            /* "Servers Of" */
  120.     kParentCIDAttrTypeNum        = 1027,                            /* "Parent CID" */
  121.     kNetworkSpecAttrTypeNum        = 1028,                            /* "NetworkSpec" */
  122.     kLocationAttrTypeNum        = 1029,                            /* "Location" */
  123.     kTimeSvrTypeAttrTypeNum        = 1030,                            /* "TimeServer Type" */
  124.     kUpdateTimerAttrTypeNum        = 1031,                            /* "Update Timer" */
  125.     kShadowsOfAttrTypeNum        = 1032,                            /* "Shadows Of" */
  126.     kShadowServerAttrTypeNum    = 1033,                            /* "Shadow Server" */
  127.     kTBSetupAttrTypeNum            = 1034,                            /* "TB Setup" */
  128.     kMailSetupAttrTypeNum        = 1035,                            /* "Mail Setup" */
  129.     kSlotIDAttrTypeNum            = 1036,                            /* "SlotID" */
  130.     kGatewayFileIDAttrTypeNum    = 1037,                            /* "Gateway FileID" */
  131.     kMailServiceAttrTypeNum        = 1038,                            /* "Mail Service" */
  132.     kStdSlotInfoAttrTypeNum        = 1039,                            /* "Std Slot Info" */
  133.     kAssoDirectoryAttrTypeNum    = 1040,                            /* "Asso. Directory" */
  134.     kDirectoryAttrTypeNum        = 1041,                            /* "Directory" */
  135.     kDirectoriesAttrTypeNum        = 1042,                            /* "Directories" */
  136.     kSFlagsAttrTypeNum            = 1043,                            /* "SFlags" */
  137.     kLocalNameAttrTypeNum        = 1044,                            /* "Local Name" */
  138.     kLocalKeyAttrTypeNum        = 1045,                            /* "Local Key" */
  139.     kDirUserRIDAttrTypeNum        = 1046,                            /* "Dir User RID" */
  140.     kDirUserKeyAttrTypeNum        = 1047,                            /* "Dir User Key" */
  141.     kDirNativeNameAttrTypeNum    = 1048,                            /* "Dir Native Name" */
  142.     kCommentAttrTypeNum            = 1049,                            /* "Comment" */
  143.     kRealNameAttrTypeNum        = 1050,                            /* "Real Name" */
  144.     kPrivateDataAttrTypeNum        = 1051,                            /* "Private Data" */
  145.     kDirTypeAttrTypeNum            = 1052,                            /* "Directory Type" */
  146.     kDSAMFileAliasAttrTypeNum    = 1053,                            /* "DSAM File Alias" */
  147.     kCanAddressToAttrTypeNum    = 1054,                            /* "Can Address To" */
  148.     kDiscriminatorAttrTypeNum    = 1055,                            /* "Discriminator" */
  149.     kAliasAttrTypeNum            = 1056,                            /* "Alias" */
  150.     kParentMSAMAttrTypeNum        = 1057,                            /* "Parent MSAM" */
  151.     kParentDSAMAttrTypeNum        = 1058,                            /* "Parent DSAM" */
  152.     kSlotAttrTypeNum            = 1059,                            /* "Slot" */
  153.     kAssoMailServiceAttrTypeNum    = 1060,                            /* "Asso. Mail Service" */
  154.     kFakeAttrTypeNum            = 1061,                            /* "Fake" */
  155.     kInheritSysAdminAttrTypeNum    = 1062,                            /* "Inherit SysAdministrators" */
  156.     kPreferredPDAttrTypeNum        = 1063,                            /* "Preferred PD" */
  157.     kLastLoginAttrTypeNum        = 1064,                            /* "Last Login" */
  158.     kMailerAOMStateAttrTypeNum    = 1065,                            /* "Mailer AOM State" */
  159.     kMailerSendOptionsAttrTypeNum = 1066,                        /* "Mailer Send Options" */
  160.     kJoinedAttrTypeNum            = 1067,                            /* "Joined" */
  161.     kUnconfiguredAttrTypeNum    = 1068,                            /* "Unconfigured" */
  162.     kVersionAttrTypeNum            = 1069,                            /* "Version" */
  163.     kLocationNamesAttrTypeNum    = 1070,                            /* "Location Names" */
  164.     kActiveAttrTypeNum            = 1071,                            /* "Active" */
  165.     kDeleteRequestedAttrTypeNum    = 1072,                            /* "Delete Requested" */
  166.     kGatewayTypeAttrTypeNum        = 1073,                            /* "Gateway Type" */
  167.     kFirstOCEAttrTypeNum        = kMemberAttrTypeNum,            /* first standard OCE attr type */
  168.     kLastOCEAttrTypeNum            = kGatewayTypeAttrTypeNum,        /* last standard OCE attr type */
  169.     kNumOCEAttrTypes            = (kLastOCEAttrTypeNum - kFirstOCEAttrTypeNum + 1)
  170. };
  171.  
  172. #endif
  173. #endif /* REZ */
  174.  
  175. /* Standard definitions for certain record types: */
  176.  
  177. #define  kUserRecTypeBody             "aoce User"
  178. #define  kGroupRecTypeBody            "aoce Group"
  179. #define  kMnMRecTypeBody            "aoce AppleMail[tm] M&M"
  180. #define  kMnMForwarderRecTypeBody    "aoce AppleMail[tm] Fwdr"
  181. #define  kNetworkSpecRecTypeBody    "aoce NetworkSpec"
  182. #define  kADAPServerRecTypeBody        "aoce ADAP Server"
  183. #define  kADAPDNodeRecTypeBody        "aoce ADAP DNode"
  184. #define  kADAPDNodeRepRecTypeBody    "aoce ADAP DNode Rep"
  185. #define  kServerSetupRecTypeBody    "aoce Server Setup"
  186. #define  kDirectoryRecTypeBody        "aoce Directory"
  187. #define  kDNodeRecTypeBody            "aoce DNode"
  188. #define  kSetupRecTypeBody            "aoce Setup"
  189. #define  kMSAMRecTypeBody            "aoce MSAM"
  190. #define  kDSAMRecTypeBody            "aoce DSAM"
  191. #define  kAttributeValueRecTypeBody    "aoce Attribute Value"
  192. #define  kBusinessCardRecTypeBody    "aoce Business Card"
  193. #define  kMailServiceRecTypeBody    "aoce Mail Service"
  194. #define  kCombinedRecTypeBody        "aoce Combined"
  195. #define  kOtherServiceRecTypeBody    "aoce Other Service"
  196. #define  kAFPServiceRecTypeBody        "aoce Other Service afps"
  197.  
  198. /* Standard definitions for certain attribute types: */
  199.  
  200. #define  kMemberAttrTypeBody        "aoce Member"
  201. #define  kAdminsAttrTypeBody        "aoce Administrators"
  202. #define  kMailSlotsAttrTypeBody        "aoce mailslots"
  203. #define  kPrefMailAttrTypeBody        "aoce pref mailslot"
  204. #define  kAddressAttrTypeBody        "aoce Address"
  205. #define  kPictureAttrTypeBody        "aoce Picture"
  206. #define  kAuthKeyAttrTypeBody        "aoce auth key"
  207. #define  kTelephoneAttrTypeBody        "aoce Telephone"
  208. #define  kNBPNameAttrTypeBody        "aoce NBP Name"
  209. #define  kQMappingAttrTypeBody        "aoce ForwarderQMap"
  210. #define  kDialupSlotAttrTypeBody    "aoce DialupSlotInfo"
  211. #define  kHomeNetAttrTypeBody        "aoce Home Internet"
  212. #define  kCoResAttrTypeBody            "aoce Co-resident M&M"
  213. #define  kFwdrLocalAttrTypeBody        "aoce FwdrLocalRecord"
  214. #define  kConnectAttrTypeBody        "aoce Connected To"
  215. #define  kForeignAttrTypeBody        "aoce Foreign RLIs"
  216. #define  kOwnersAttrTypeBody        "aoce Owners"
  217. #define  kReadListAttrTypeBody        "aoce ReadList"
  218. #define  kWriteListAttrTypeBody        "aoce WriteList"
  219. #define  kDescriptorAttrTypeBody    "aoce Descriptor"
  220. #define  kCertificateAttrTypeBody    "aoce Certificate"
  221. #define  kMsgQsAttrTypeBody            "aoce MessageQs"
  222. #define  kPrefMsgQAttrTypeBody        "aoce PrefMessageQ"
  223. #define  kMasterPFAttrTypeBody        "aoce MasterPF"
  224. #define  kMasterNetSpecAttrTypeBody    "aoce MasterNetSpec"
  225. #define  kServersOfAttrTypeBody        "aoce Servers Of"
  226. #define  kParentCIDAttrTypeBody        "aoce Parent CID"
  227. #define  kNetworkSpecAttrTypeBody    "aoce NetworkSpec"
  228. #define  kLocationAttrTypeBody        "aoce Location"
  229. #define  kTimeSvrTypeAttrTypeBody    "aoce TimeServer Type"
  230. #define  kUpdateTimerAttrTypeBody    "aoce Update Timer"
  231. #define  kShadowsOfAttrTypeBody        "aoce Shadows Of"
  232. #define  kShadowServerAttrTypeBody    "aoce Shadow Server"
  233. #define  kTBSetupAttrTypeBody        "aoce TB Setup"
  234. #define  kMailSetupAttrTypeBody        "aoce Mail Setup"
  235. #define  kSlotIDAttrTypeBody        "aoce SlotID"
  236. #define  kGatewayFileIDAttrTypeBody    "aoce Gateway FileID"
  237. #define  kMailServiceAttrTypeBody    "aoce Mail Service"
  238. #define  kStdSlotInfoAttrTypeBody    "aoce Std Slot Info"
  239. #define  kAssoDirectoryAttrTypeBody    "aoce Asso. Directory"
  240. #define  kDirectoryAttrTypeBody        "aoce Directory"
  241. #define  kDirectoriesAttrTypeBody    "aoce Directories"
  242. #define  kSFlagsAttrTypeBody        "aoce SFlags"
  243. #define  kLocalNameAttrTypeBody        "aoce Local Name"
  244. #define  kLocalKeyAttrTypeBody        "aoce Local Key"
  245. #define  kDirUserRIDAttrTypeBody    "aoce Dir User RID"
  246. #define  kDirUserKeyAttrTypeBody    "aoce Dir User Key"
  247. #define  kDirNativeNameAttrTypeBody    "aoce Dir Native Name"
  248. #define  kCommentAttrTypeBody        "aoce Comment"
  249. #define  kRealNameAttrTypeBody        "aoce Real Name"
  250. #define  kPrivateDataAttrTypeBody    "aoce Private Data"
  251. #define  kDirTypeAttrTypeBody        "aoce Directory Type"
  252. #define  kDSAMFileAliasAttrTypeBody    "aoce DSAM File Alias"
  253. #define  kCanAddressToAttrTypeBody    "aoce Can Address To"
  254. #define  kDiscriminatorAttrTypeBody    "aoce Discriminator"
  255. #define  kAliasAttrTypeBody            "aoce Alias"
  256. #define  kParentMSAMAttrTypeBody    "aoce Parent MSAM"
  257. #define  kParentDSAMAttrTypeBody    "aoce Parent DSAM"
  258. #define  kSlotAttrTypeBody                "aoce Slot"
  259. #define  kAssoMailServiceAttrTypeBody     "aoce Asso. Mail Service"
  260. #define  kFakeAttrTypeBody                "aoce Fake"
  261. #define  kInheritSysAdminAttrTypeBody     "aoce Inherit SysAdministrators"
  262. #define  kPreferredPDAttrTypeBody        "aoce Preferred PD"
  263. #define  kLastLoginAttrTypeBody            "aoce Last Login"
  264. #define  kMailerAOMStateAttrTypeBody    "aoce Mailer AOM State"
  265. #define  kMailerSendOptionsAttrTypeBody "aoce Mailer Send Options"
  266. #define  kJoinedAttrTypeBody            "aoce Joined"
  267. #define  kUnconfiguredAttrTypeBody        "aoce Unconfigured"
  268. #define  kVersionAttrTypeBody            "aoce Version"
  269. #define  kLocationNamesAttrTypeBody        "aoce Location Names"
  270. #define  kActiveAttrTypeBody            "aoce Active"
  271. #define  kDeleteRequestedAttrTypeBody     "aoce Delete Requested"
  272. #define  kGatewayTypeAttrTypeBody         "aoce Gateway Type"
  273. #ifndef REZ
  274. #if FOR_SYSTEM7_ONLY
  275. /* Miscellaneous enums: */
  276.  
  277. enum {
  278.     kRString32Size                = 32,                            /* max size of the body field in RString32 */
  279.     kRString64Size                = 64,                            /* max size of the body field in RString64 */
  280.     kNetworkSpecMaxBytes        = 32,                            /* max size of the body field in NetworkSpec */
  281.     kPathNameMaxBytes            = 1024,                            /* max size of the data field in PackedPathName */
  282.     kDirectoryNameMaxBytes        = 32,                            /* max size of the body field in DirectoryName */
  283.     kAttributeTypeMaxBytes        = 32,                            /* max size of the body field in AttributeType */
  284.     kAttrValueMaxBytes            = 65536L,                        /* max size of any attribute value */
  285.     kRStringMaxBytes            = 256,                            /* max size (in bytes) of the body field of a recordName or recordType */
  286.     kRStringMaxChars            = 128                            /* max size (in chars) of the body field of a recordName or recordType */
  287. };
  288.  
  289.  
  290. enum {
  291.     kNULLDNodeNumber            = 0,                            /* Special value meaning none specified */
  292.     kRootDNodeNumber            = 2                                /* DNodeNum corresponding to the root of the tree */
  293. };
  294.  
  295. /*
  296.  This enum is used to select the kind of RString in calls such as OCERelRString,
  297. OCEEqualRString, and OCEValidRString.
  298.  
  299. eGenericSensitive and eGenericInsensitive are enumerators that can be used if you
  300. use RStrings for things other than what you see in this file.  If you want them to
  301. be compared in a case- and diacritical-sensitive manner (c != C != Á), use
  302. eGenericSensitive.  If you want them to be compared in a case- and diacritical-
  303. insensitive manner (c = C = Á), use eGenericInensitive.
  304. WARNING:  do not use eGenericSensitive and eGenericInsensitive with catalog
  305. names, entity names, pathname parts, entity types, network specs, or attribute
  306. types!  Don't assume that you know how they should be compared!!! 
  307. */
  308.  
  309. enum {
  310.     kOCEDirName                    = 0,
  311.     kOCERecordOrDNodeName        = 1,
  312.     kOCERecordType                = 2,
  313.     kOCENetworkSpec                = 3,
  314.     kOCEAttrType                = 4,
  315.     kOCEGenericSensitive        = 5,
  316.     kOCEGenericInsensitive        = 6
  317. };
  318.  
  319. typedef unsigned short RStringKind;
  320. /* Values for the signature field in Discriminator */
  321.  
  322. enum {
  323.     kDirAllKinds                = 0,
  324.     kDirADAPKind                = 'adap',
  325.     kDirPersonalDirectoryKind    = 'pdir',
  326.     kDirDSAMKind                = 'dsam'
  327. };
  328.  
  329. typedef unsigned long OCEDirectoryKind;
  330. /* Values returned by GetDSSpecInfo() */
  331.  
  332. enum {
  333.     kOCEInvalidDSSpec            = 0x3F3F3F3F,                    /* '????' could not be determined */
  334.     kOCEDirsRootDSSpec            = 'root',                        /* root of all catalogs ("Catalogs" icon) */
  335.     kOCEDirectoryDSSpec            = 'dire',                        /* catalog */
  336.     kOCEDNodeDSSpec                = 'dnod',                        /* d-node */
  337.     kOCERecordDSSpec            = 'reco',                        /* record */
  338.     kOCEentnDSSpec                = 'entn',                        /* extensionType is 'entn' */
  339.     kOCENOTentnDSSpec            = 'not '                        /* extensionType is not 'entn' */
  340. };
  341.  
  342. /* Values for AttributeTag */
  343.  
  344. enum {
  345.     typeRString                    = 'rstr',
  346.     typePackedDSSpec            = 'dspc',
  347.     typeBinary                    = 'bnry'
  348. };
  349.  
  350. /*
  351.  Bit flag corresponding to the canContainRecords bit.  Use it like this:
  352.     if (foo & kCanContainRecords)
  353.         then this dNode can contain records!
  354. kForeignNode is used to indicate nodes in the name hierarchy that correspond to
  355. foreign catalogs (meaning ADAP sees no clusters or DNodes beneath it, but
  356. mail routers might be able to route to clusters beneath it. 
  357. */
  358.  
  359. enum {
  360.     kCanContainRecordsBit        = 0,
  361.     kForeignNodeBit                = 1
  362. };
  363.  
  364. /* DirNodeKind */
  365.  
  366. enum {
  367.     kCanContainRecords            = 1L << kCanContainRecordsBit,
  368.     kForeignNode                = 1L << kForeignNodeBit
  369. };
  370.  
  371. typedef unsigned long DirNodeKind;
  372. /**** Toolbox Control ****/
  373. /*
  374.  We will have a version number and attributes for toolboxes off the aa5e trap
  375. and the S&F server trap.
  376.  
  377. This includes the OCE toolbox and S&F Server.  [Note: the S&F server will
  378. change to ONLY service ServerGateway calls --it will then be necessary to run
  379. it co-resident with an OCE toolbox].
  380.  
  381. The high order word will represent the S&F Server version number.  The low
  382. order word will represent the OCE toolbox version number.  These will be zero
  383. until the component is up and running.  It is not possible to know these
  384. a-priori. Note: there will not be a seperate version numbers for each component
  385. in the OCE toolbox or S&F server.
  386.  
  387. The above is consistent with the standard System 7.0 usage of Gestalt.
  388.  
  389. The oce tb attribute gestaltOCETBPresent implies the existence of OCE on a
  390. machine.
  391.  
  392. The OCE TB attribute gestaltOCETBAvailable implies the availablity of OCE calls.
  393.  
  394. The attribute gestaltOCESFServerAvailable implies the availablity of OCE calls
  395. available through the S&F server. This are essentially the server gateway calls.
  396.  
  397. Any (future) remaining OCE attributes may not be established correctly until
  398. the attribute gestaltOCETBAvailable is set.
  399.  
  400. The gestalt selectors and values are listed below: 
  401. */
  402.  
  403. enum {
  404.     gestaltOCEToolboxVersion    = 'ocet',                        /* OCE Toolbox version */
  405.     gestaltOCEToolboxAttr        = 'oceu'                        /* OCE Toolbox attributes */
  406. };
  407.  
  408. /*
  409.  version includes:
  410.  *  dirtb
  411.  *  authtb
  412.  *  mailtb
  413.  *  ipmtb
  414.  *  personal catalog
  415.  *  ADSPSecure
  416.  * e.g. all interfaces dependent on the aa5e trap. 
  417. */
  418.  
  419. enum {
  420.     gestaltOCETB                = 0x0102,                        /* OCE Toolbox version 1.02 */
  421.     gestaltSFServer                = 0x0100,                        /* S&F Server version 1.0 */
  422.     gestaltOCETBPresent            = 0x01,                            /* OCE toolbox is present, not running */
  423.     gestaltOCETBAvailable        = 0x02,                            /* OCE toolbox is running and available */
  424.     gestaltOCESFServerAvailable    = 0x04,                            /* S&F Server is running and available */
  425.     gestaltOCETBNativeGlueAvailable = 0x10                        /* Native PowerPC Glue routines are availible */
  426. };
  427.  
  428. /*    Constants used for Transitions. */
  429.  
  430. enum {
  431.     ATTransIPMStart                = 'ipms',
  432.     ATTransIPMShutdown            = 'ipmd',
  433.     ATTransDirStart                = 'dirs',
  434.     ATTransDirShutdown            = 'dird',
  435.     ATTransAuthStart            = 'auts',
  436.     ATTransAuthShutdown            = 'autd',
  437.     ATTransSFStart                = 's&fs',
  438.     ATTransSFShutdown            = 's&fd'
  439. };
  440.  
  441. /* Some definitions for time-related parameters: */
  442. /* Interpreted as UTC seconds since 1/1/1904 */
  443. typedef unsigned long UTCTime;
  444. /* seconds EAST of Greenwich */
  445. typedef long UTCOffset;
  446. /* This is the same as the ScriptManager script. */
  447. typedef short CharacterSet;
  448. /**** RString ****/
  449. /*
  450.  struct RString is a maximum-sized structure.  Allocate one of these and it will
  451. hold any valid RString. 
  452. */
  453. struct RString {
  454.     CharacterSet                     charSet;
  455.     unsigned short                     dataLength;
  456.     Byte                             body[256];                    /* place for characters */
  457. };
  458. typedef struct RString RString;
  459.  
  460. /* struct ProtoRString is a minimum-sized structure.  Use this for a variable-length RString. */
  461. struct ProtoRString {
  462.     CharacterSet                     charSet;
  463.     unsigned short                     dataLength;
  464. };
  465. typedef struct ProtoRString ProtoRString;
  466.  
  467. typedef RString *RStringPtr;
  468. typedef RStringPtr *RStringHandle;
  469. typedef ProtoRString *ProtoRStringPtr;
  470. struct RString64 {
  471.     CharacterSet                     charSet;
  472.     unsigned short                     dataLength;
  473.     Byte                             body[64];
  474. };
  475. typedef struct RString64 RString64;
  476.  
  477. struct RString32 {
  478.     CharacterSet                     charSet;
  479.     unsigned short                     dataLength;
  480.     Byte                             body[32];
  481. };
  482. typedef struct RString32 RString32;
  483.  
  484. /*
  485.  Standard definitions for the entity type field and attribute type
  486. have been moved to the end of the file. 
  487. */
  488. /*
  489.  Copies str1 to str2.  str2Length is the size of str2, excluding header.
  490. A memFull error will be returned if that is not as large as str1->dataLength. 
  491. */
  492. extern pascal OSErr OCECopyRString(const RString *str1, RString *str2, unsigned short str2Length)
  493.  THREEWORDINLINE(0x303C, 0x0308, 0xAA5C);
  494.  
  495. /*
  496.     Make an RString from a C string.  If the c string is bigger than rStrLength,
  497. only rStrLength bytes will be copied. (rStrLength does not include the header size) 
  498. */
  499. extern pascal void OCECToRString(const char *cStr, CharacterSet charSet, RString *rStr, unsigned short rStrLength)
  500.  THREEWORDINLINE(0x303C, 0x0339, 0xAA5C);
  501.  
  502. /*
  503.     Make an RString from a Pascal string.  If the Pascal string is bigger than rStrLength,
  504. only rStrLength bytes will be copied. (rStrLength does not include the header size) 
  505. */
  506. extern pascal void OCEPToRString(ConstStr255Param pStr, CharacterSet charSet, RString *rStr, unsigned short rStrLength)
  507.  THREEWORDINLINE(0x303C, 0x033A, 0xAA5C);
  508.  
  509. /*
  510.     Make a Pascal string from an RString.  It's up to you to check the char set of
  511. the RString, or if the length of the RString is greater than 255 (the Pascal string's
  512. length will simply be the lower byte of the RString's length).  The StringPtr that is
  513. returned will point directly into the RString (no memory will be allocated). 
  514. */
  515. extern pascal StringPtr OCERToPString(const RString *rStr)
  516.  THREEWORDINLINE(0x303C, 0x033B, 0xAA5C);
  517.  
  518. /*
  519.     Check the relative equality of two RStrings.  Determines if str1 is greater than,
  520. equal to, or less than str2.  Result types for OCERelRString are defined in <OSUtils.h>
  521. (same as for RelString). 
  522. */
  523. extern pascal short OCERelRString(const void *str1, const void *str2, RStringKind kind)
  524.  THREEWORDINLINE(0x303C, 0x032D, 0xAA5C);
  525.  
  526. /*    Check for equality of two RStrings. Returns true if equal. */
  527. extern pascal Boolean OCEEqualRString(const void *str1, const void *str2, RStringKind kind)
  528.  THREEWORDINLINE(0x303C, 0x0316, 0xAA5C);
  529.  
  530. /*    Check the validity of an RString.  Returns true if the RString is valid */
  531. extern pascal Boolean OCEValidRString(const void *str, RStringKind kind)
  532.  THREEWORDINLINE(0x303C, 0x0338, 0xAA5C);
  533.  
  534. /**** CreationID ****/
  535. struct CreationID {
  536.     unsigned long                     source;                        /* Fields definitions and usage are not defined */
  537.     unsigned long                     seq;
  538. };
  539. typedef struct CreationID CreationID;
  540.  
  541. typedef CreationID AttributeCreationID;
  542. typedef CreationID *CreationIDPtr;
  543. /* Returns a pointer to a null CreationID . */
  544. extern pascal const CreationID *OCENullCID(void )
  545.  THREEWORDINLINE(0x303C, 0x0344, 0xAA5C);
  546.  
  547. /* Returns a pointer to a special CreationID used within the PathFinder. */
  548. extern pascal const CreationID *OCEPathFinderCID(void )
  549.  THREEWORDINLINE(0x303C, 0x033C, 0xAA5C);
  550.  
  551. /* Sets the CreationID to a null value. */
  552. extern pascal void OCESetCreationIDtoNull(CreationID *cid)
  553.  THREEWORDINLINE(0x303C, 0x032E, 0xAA5C);
  554.  
  555. /* Copies the value of cid1 to cid2. */
  556. extern pascal void OCECopyCreationID(const CreationID *cid1, CreationID *cid2)
  557.  THREEWORDINLINE(0x303C, 0x0300, 0xAA5C);
  558.  
  559. /* Check the equality of two CreationIDs. */
  560. extern pascal Boolean OCEEqualCreationID(const CreationID *cid1, const CreationID *cid2)
  561.  THREEWORDINLINE(0x303C, 0x030C, 0xAA5C);
  562.  
  563. /**** NetworkSpec ****/
  564. /*
  565.  For the record, a NetworkSpec is an RString with a smaller maximum size.
  566. I don't just typedef it to an RString, because I want the definition of the NetworkSpec
  567. struct to contain the max length.  But it should be possible to typecast any
  568. NetworkSpec to an RString and use all the RString utilities on it. 
  569. */
  570. struct NetworkSpec {
  571.     CharacterSet                     charSet;
  572.     unsigned short                     dataLength;
  573.     Byte                             body[32];                    /* always fixed at the max size */
  574. };
  575. typedef struct NetworkSpec NetworkSpec;
  576.  
  577. typedef NetworkSpec *NetworkSpecPtr;
  578. /**** PackedPathName ****/
  579. /*
  580.  struct PackedPathName is a maximum-sized structure.  Allocate one of
  581. these and it will hold any valid packed pathname. 
  582. */
  583. struct PackedPathName {
  584.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  585.     Byte                             data[1022];
  586. };
  587. typedef struct PackedPathName PackedPathName;
  588.  
  589. /*
  590.  struct ProtoPackedPathName is a minimum-sized structure.  Use this
  591. for a variable-length packed PathName. 
  592. */
  593. struct ProtoPackedPathName {
  594.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  595.                                                                 /* Followed by data */
  596. };
  597. typedef struct ProtoPackedPathName ProtoPackedPathName;
  598.  
  599. typedef PackedPathName *PackedPathNamePtr;
  600. typedef ProtoPackedPathName *ProtoPackedPathNamePtr;
  601. /*
  602. Copy the contents of path1 to path2.  path2Length is the size of path2, and must
  603. be large enough to hold a copy of path1.  A memFull error will be returned if that
  604. is not the case.
  605. */
  606. extern pascal OSErr OCECopyPackedPathName(const PackedPathName *path1, PackedPathName *path2, unsigned short path2Length)
  607.  THREEWORDINLINE(0x303C, 0x0304, 0xAA5C);
  608.  
  609. /*
  610. Returns true if packed path pointer is nil, or is of zero length, or is of
  611. length 2 and nParts of zero.
  612. */
  613. extern pascal Boolean OCEIsNullPackedPathName(const PackedPathName *path)
  614.  THREEWORDINLINE(0x303C, 0x031D, 0xAA5C);
  615.  
  616. /*
  617. OCEUnpackPathName breaks apart the path into its component RStrings, writing string
  618. pointers into the array 'parts', which the client asserts can hold as many as
  619. 'nParts' elements. The number of parts actually found is returned.  Strings are
  620. placed in the array in order from lowest to highest.  The first pathName element
  621. beneath the root appears last.  NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO
  622. THE PACKED STRUCT - DON'T DELETE OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED
  623. WITH THE UNPACKED STRUCT AS WELL
  624. */
  625. extern pascal unsigned short OCEUnpackPathName(const PackedPathName *path, RString *const parts[], unsigned short nParts)
  626.  THREEWORDINLINE(0x303C, 0x0330, 0xAA5C);
  627.  
  628. /*
  629. OCEPackedPathNameSize computes the number of bytes of memory needed to hold a
  630. PackedPathName manufactured from the array of parts.  This length
  631. includes the length of the length field of PackedPathName, so it
  632. is safe to do a NewPtr (OCEPackedPathNameSize(...)).
  633. */
  634. extern pascal unsigned short OCEPackedPathNameSize(const RStringPtr parts[], unsigned short nParts)
  635.  THREEWORDINLINE(0x303C, 0x0328, 0xAA5C);
  636.  
  637. /* OCEDNodeNameCount returns the number of RStrings contained within the path. */
  638. extern pascal unsigned short OCEDNodeNameCount(const PackedPathName *path)
  639.  THREEWORDINLINE(0x303C, 0x032C, 0xAA5C);
  640.  
  641. /*
  642. OCEPackPathName packs the parts into the storage provided as 'path'.  path must be
  643. large enough to hold the packed pathname.  A memFull error will be returned if
  644. pathLength is too small.  parts[0] should contain the deepest pathName element,
  645. and parts[nParts - 1] should contain the name of the first pathName element beneath
  646. the root. 
  647. */
  648. extern pascal OSErr OCEPackPathName(const RStringPtr parts[], unsigned short nParts, PackedPathName *path, unsigned short pathLength)
  649.  THREEWORDINLINE(0x303C, 0x0323, 0xAA5C);
  650.  
  651. /*
  652. Check the equality of two packed paths.
  653. */
  654. extern pascal Boolean OCEEqualPackedPathName(const PackedPathName *path1, const PackedPathName *path2)
  655.  THREEWORDINLINE(0x303C, 0x0311, 0xAA5C);
  656.  
  657. /*
  658. OCEValidPackedPathName checks that the packed PathName is internally consistent.
  659. Returns true if it's ok.
  660. */
  661. extern pascal Boolean OCEValidPackedPathName(const PackedPathName *path)
  662.  THREEWORDINLINE(0x303C, 0x0334, 0xAA5C);
  663.  
  664. /**** DirDiscriminator ****/
  665. struct DirDiscriminator {
  666.     OCEDirectoryKind                 signature;
  667.     unsigned long                     misc;
  668. };
  669. typedef struct DirDiscriminator DirDiscriminator;
  670.  
  671. /* Copies the value of disc1 to disc2. */
  672. extern pascal void OCECopyDirDiscriminator(const DirDiscriminator *disc1, DirDiscriminator *disc2)
  673.  THREEWORDINLINE(0x303C, 0x0301, 0xAA5C);
  674.  
  675. /* Check the equality of two DirDiscriminators. */
  676. extern pascal Boolean OCEEqualDirDiscriminator(const DirDiscriminator *disc1, const DirDiscriminator *disc2)
  677.  THREEWORDINLINE(0x303C, 0x030D, 0xAA5C);
  678.  
  679. /*
  680. This structure is called RLI because it really contains all the info you
  681. need to locate a record within the entire name space.  It contains four fields.
  682. The first two are the name of the catalog and a catalog discriminator.  These
  683. two fields are used to indicate to which catalog a given record belongs.  The
  684. discriminator is used to distinguish between two different catalogs that have
  685. the same name.
  686.  
  687. The other two fields in the RLI structure are used to indicate a particular
  688. catalog node within the catalog specified by the directoryName and
  689. discriminator fields.  These fields are exactly analagous to the dirID and
  690. pathname used in HFS.  It is possible to specify a dNode just by dNodeNumber
  691. (pathname is nil), or just by pathname (dNodeNumber is set to kNULLDNodeNumber),
  692. or by a combination of the two.  The latter is called a 'partial pathname', and
  693. while it is valid in the Catalog Manager API, it is not supported by ADAP
  694. catalogs in Release 1.
  695.  
  696. Note that the path parameter does not include the catalog name, but holds
  697. the names of all the nodes on the path to the desired catalog node, starting
  698. with the catalog node and working its way up the tree.
  699. */
  700. /**** RLI ****/
  701. struct DirectoryName {
  702.     CharacterSet                     charSet;
  703.     unsigned short                     dataLength;
  704.     Byte                             body[32];                    /* space for catalog name */
  705. };
  706. typedef struct DirectoryName DirectoryName;
  707.  
  708. typedef DirectoryName *DirectoryNamePtr;
  709. /* Catalog node number */
  710. typedef unsigned long DNodeNum;
  711. struct RLI {
  712.     DirectoryNamePtr                 directoryName;                /* pointer to the name of the catalog root */
  713.     DirDiscriminator                 discriminator;                /* used to discriminate between dup catalog names */
  714.     DNodeNum                         dNodeNumber;                /* number of the node */
  715.     PackedPathNamePtr                 path;                        /* old-style RLI */
  716. };
  717. typedef struct RLI RLI;
  718.  
  719. typedef RLI *RLIPtr;
  720. /*
  721. Create a new RLI from the catalog name, discriminator, DNode number, and
  722. PackedPathName.  You must allocate the storage for the RLI and pass in a pointer
  723. to it.
  724. */
  725. extern pascal void OCENewRLI(RLI *newRLI, const DirectoryName *dirName, DirDiscriminator *discriminator, DNodeNum dNodeNumber, const PackedPathName *path)
  726.  THREEWORDINLINE(0x303C, 0x031F, 0xAA5C);
  727.  
  728. /*
  729. Duplicate the contents of rli1 to rli2.  No errors are returned. This
  730. simply copies the pointers to the catalog name and path, wiping out any pointer
  731. that you might have had in there.
  732. */
  733. extern pascal void OCEDuplicateRLI(const RLI *rli1, RLI *rli2)
  734.  THREEWORDINLINE(0x303C, 0x030B, 0xAA5C);
  735.  
  736. /*
  737. Copy the contents of rli1 to rli2.  rli2 must already contain
  738. pointers to structures large enough to hold copies of the corresponding
  739. fields from rli1.  A memFull error will be returned if that is not the case.
  740. So if you allocate a brand new empty destination, you must at least set up
  741. its length fields.
  742. */
  743. extern pascal OSErr OCECopyRLI(const RLI *rli1, RLI *rli2)
  744.  THREEWORDINLINE(0x303C, 0x0307, 0xAA5C);
  745.  
  746. /*
  747. Check the equality of two RLIs.  This will take into account differences
  748. in the case and diacriticals of the directoryName and the PathName.
  749. NOTE THAT THIS WILL FAIL IF rli1 CONTAINS A DNODENUMBER AND A NIL PATHNAME,
  750. AND rli2 CONTAINS kNULLDNodeNumber AND A NON-NIL PATHNAME.  IN OTHER WORDS,
  751. THE TWO rlis MUST BE OF THE SAME FORM TO CHECK FOR EQUALITY.
  752. The one exception is that if the pathname is nil, a dNodeNumber of zero and
  753. kRootDNodeNumber will be treated as equal.
  754. */
  755. extern pascal Boolean OCEEqualRLI(const RLI *rli1, const RLI *rli2)
  756.  THREEWORDINLINE(0x303C, 0x0315, 0xAA5C);
  757.  
  758. /*
  759. Check the validity of an RLI.  This checks that the catalog name length
  760. is within bounds, and the packed pathname (if specified) is valid.
  761. */
  762. extern pascal Boolean OCEValidRLI(const RLI *theRLI)
  763.  THREEWORDINLINE(0x303C, 0x0337, 0xAA5C);
  764.  
  765. /**** PackedRLI ****/
  766. /*
  767. struct PackedRLI is a maximum-sized structure.  Allocate one of
  768. these and it will hold any valid packed pathname.
  769. */
  770.  
  771. enum {
  772.     kRLIMaxBytes                = (sizeof(RString) + sizeof(DirDiscriminator) + sizeof(DNodeNum) + kPathNameMaxBytes)
  773. };
  774.  
  775. struct PackedRLI {
  776.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  777.     Byte                             data[1296];
  778. };
  779. typedef struct PackedRLI PackedRLI;
  780.  
  781. /*
  782. struct ProtoPackedRLI is a minimum-sized structure.  Use this
  783. for a variable-length packed RLI.
  784. */
  785. struct ProtoPackedRLI {
  786.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  787.                                                                 /* Followed by data */
  788. };
  789. typedef struct ProtoPackedRLI ProtoPackedRLI;
  790.  
  791. typedef PackedRLI *PackedRLIPtr;
  792. typedef ProtoPackedRLI *ProtoPackedRLIPtr;
  793. /*
  794. Copy the contents of prli1 to prli2.  prli2Length is the size of prli2, and must
  795. be large enough to hold a copy of prli1.  A memFull error will be returned if that
  796. is not the case.
  797. */
  798. extern pascal OSErr OCECopyPackedRLI(const PackedRLI *prli1, PackedRLI *prli2, unsigned short prli2Length)
  799.  THREEWORDINLINE(0x303C, 0x0305, 0xAA5C);
  800.  
  801. /*
  802. OCEUnpackRLI breaks apart the prli into its components, writing pointers into
  803. the rli structure.  NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO THE
  804. PACKED STRUCT - DON'T DELETE OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED
  805. WITH THE UNPACKED STRUCT AS WELL
  806. */
  807. extern pascal void OCEUnpackRLI(const PackedRLI *prli, RLI *theRLI)
  808.  THREEWORDINLINE(0x303C, 0x0331, 0xAA5C);
  809.  
  810. /*
  811. OCEPackedRLISize computes the number of bytes of memory needed to hold a
  812. PackedRLI manufactured from an RLI.  This length
  813. includes the length of the length field of PackedRLI, so it
  814. is safe to do a NewPtr (OCEPackedRLISize(...)).
  815. */
  816. extern pascal unsigned short OCEPackedRLISize(const RLI *theRLI)
  817.  THREEWORDINLINE(0x303C, 0x032A, 0xAA5C);
  818.  
  819. /*
  820. OCEPackRLI packs the RLI into the storage provided as 'prli'.  prli must be
  821. large enough to hold the packed RLI.  A memFull error will be returned if
  822. prliLength is too small.
  823. */
  824. extern pascal OSErr OCEPackRLI(const RLI *theRLI, PackedRLI *prli, unsigned short prliLength)
  825.  THREEWORDINLINE(0x303C, 0x0324, 0xAA5C);
  826.  
  827. /*
  828. OCEPackedRLIPartsSize computes the number of bytes of memory needed to hold a
  829. PackedRLI manufactured from the parts of an RLI.  This length
  830. includes the length of the length field of PackedRLI, so it
  831. is safe to do a NewPtr (OCEPackedRLIPartsSize(...)).
  832. */
  833. extern pascal unsigned short OCEPackedRLIPartsSize(const DirectoryName *dirName, const RStringPtr parts[], unsigned short nParts)
  834.  THREEWORDINLINE(0x303C, 0x0329, 0xAA5C);
  835.  
  836. /*
  837. OCEPackRLIParts packs the parts of an RLI into the storage provided as 'prli'.
  838. prli must be large enough to hold the packed RLI.  A memFull error will be returned
  839. if prliLength is too small.
  840. */
  841. extern pascal OSErr OCEPackRLIParts(const DirectoryName *dirName, const DirDiscriminator *discriminator, DNodeNum dNodeNumber, const RStringPtr parts[], unsigned short nParts, PackedRLI *prli, unsigned short prliLength)
  842.  THREEWORDINLINE(0x303C, 0x0325, 0xAA5C);
  843.  
  844. /*
  845. Check the equality of two packed prlis.
  846. */
  847. extern pascal Boolean OCEEqualPackedRLI(const PackedRLI *prli1, const PackedRLI *prli2)
  848.  THREEWORDINLINE(0x303C, 0x0313, 0xAA5C);
  849.  
  850. /*
  851. Check the validity of a packed RLI.  This checks that the catalog name length
  852. is within bounds, and the packed pathname (if specified) is valid.
  853. */
  854. extern pascal Boolean OCEValidPackedRLI(const PackedRLI *prli)
  855.  THREEWORDINLINE(0x303C, 0x0336, 0xAA5C);
  856.  
  857. /*
  858. If this packed RLI describes a Personal Catalog, this call will return a pointer
  859. to an alias record that can be used to find the actual file.  Otherwise, it returns nil.
  860. */
  861. extern pascal AliasPtr OCEExtractAlias(const PackedRLI *prli)
  862.  THREEWORDINLINE(0x303C, 0x0318, 0xAA5C);
  863.  
  864. /*
  865. This call returns a pointer to a packed RLI that represents the "Catalogs" icon, or
  866. the root of all catalogs.  It is used in the CollabPack.
  867. */
  868. extern pascal const PackedRLI *OCEGetDirectoryRootPackedRLI(void )
  869.  THREEWORDINLINE(0x303C, 0x0346, 0xAA5C);
  870.  
  871. /**** LocalRecordID ****/
  872. struct LocalRecordID {
  873.     CreationID                         cid;
  874.     RStringPtr                         recordName;
  875.     RStringPtr                         recordType;
  876. };
  877. typedef struct LocalRecordID LocalRecordID;
  878.  
  879. typedef LocalRecordID *LocalRecordIDPtr;
  880. /* Create a LocalRecordID from a name, type, and CreationID */
  881. extern pascal void OCENewLocalRecordID(const RString *recordName, const RString *recordType, const CreationID *cid, LocalRecordID *lRID)
  882.  THREEWORDINLINE(0x303C, 0x031E, 0xAA5C);
  883.  
  884. /*
  885. Copy LocalRecordID lRID1 to LocalRecordID lRID2.  lRID2 must already contain
  886. pointers to RString structures large enough to hold copies of the corresponding
  887. fields from lRID1.  A memFull error will be returned if that is not the case.
  888. So if you allocate a brand new empty destination, you must at least set up
  889. its length field.
  890. */
  891. extern pascal OSErr OCECopyLocalRecordID(const LocalRecordID *lRID1, LocalRecordID *lRID2)
  892.  THREEWORDINLINE(0x303C, 0x0302, 0xAA5C);
  893.  
  894. /*
  895. Check the equality of two local RIDs.
  896. */
  897. extern pascal Boolean OCEEqualLocalRecordID(const LocalRecordID *lRID1, const LocalRecordID *lRID2)
  898.  THREEWORDINLINE(0x303C, 0x030F, 0xAA5C);
  899.  
  900. /**** ShortRecordID ****/
  901. struct ShortRecordID {
  902.     PackedRLIPtr                     rli;
  903.     CreationID                         cid;
  904. };
  905. typedef struct ShortRecordID ShortRecordID;
  906.  
  907. typedef ShortRecordID *ShortRecordIDPtr;
  908. /* Create a ShortRecordID from an RLI struct and a CreationID */
  909. extern pascal void OCENewShortRecordID(const PackedRLI *theRLI, const CreationID *cid, ShortRecordIDPtr sRID)
  910.  THREEWORDINLINE(0x303C, 0x0321, 0xAA5C);
  911.  
  912. /*
  913. Copy ShortRecordID sRID1 to ShortRecordID sRID2.  sRID2 must already contain
  914. pointers to structures large enough to hold copies of the corresponding
  915. fields from sRID1.  A memFull error will be returned if that is not the case.
  916. So if you allocate a brand new empty destination, you must at least set up
  917. its length fields.
  918. */
  919. extern pascal OSErr OCECopyShortRecordID(const ShortRecordID *sRID1, ShortRecordID *sRID2)
  920.  THREEWORDINLINE(0x303C, 0x030A, 0xAA5C);
  921.  
  922. /*
  923. Check the equality of two short RIDs.
  924. */
  925. extern pascal Boolean OCEEqualShortRecordID(const ShortRecordID *sRID1, const ShortRecordID *sRID2)
  926.  THREEWORDINLINE(0x303C, 0x0317, 0xAA5C);
  927.  
  928. /**** RecordID ****/
  929. struct RecordID {
  930.     PackedRLIPtr                     rli;                        /* pointer to a packed rli structure */
  931.     LocalRecordID                     local;
  932. };
  933. typedef struct RecordID RecordID;
  934.  
  935. typedef RecordID *RecordIDPtr;
  936. /*
  937.     Create a RecordID from a packed RLI struct and a LocalRecordID.
  938. This doesn't allocate any new space; the RecordID points to the same
  939. packed RLI struct and the same name and type RStrings. 
  940. */
  941. extern pascal void OCENewRecordID(const PackedRLI *theRLI, const LocalRecordID *lRID, RecordID *rid)
  942.  THREEWORDINLINE(0x303C, 0x0320, 0xAA5C);
  943.  
  944. /*
  945. Copy RecordID RID1 to RecordID RID2.  RID2 must already contain
  946. pointers to structures large enough to hold copies of the corresponding
  947. fields from lRID1.  A memFull error will be returned if that is not the case.
  948. So if you allocate a brand new empty destination, you must at least set up
  949. its length fields.
  950. */
  951. extern pascal OSErr OCECopyRecordID(const RecordID *rid1, const RecordID *rid2)
  952.  THREEWORDINLINE(0x303C, 0x0309, 0xAA5C);
  953.  
  954. /*    Check the equality of two RIDs. */
  955. extern pascal Boolean OCEEqualRecordID(const RecordID *rid1, const RecordID *rid2)
  956.  THREEWORDINLINE(0x303C, 0x0314, 0xAA5C);
  957.  
  958. /**** PackedRecordID ****/
  959. /*
  960. struct PackedRecordID is a maximum-sized structure.  Allocate one of
  961. these and it will hold any valid packed RecordID.
  962. */
  963.  
  964. enum {
  965.     kPackedRecordIDMaxBytes        = (kPathNameMaxBytes + sizeof(DNodeNum) + sizeof(DirDiscriminator) + sizeof(CreationID) + (3 * sizeof(RString)))
  966. };
  967.  
  968. struct PackedRecordID {
  969.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  970.     Byte                             data[1824];
  971. };
  972. typedef struct PackedRecordID PackedRecordID;
  973.  
  974. /*
  975. struct ProtoPackedRecordID is a minimum-sized structure.  Use this
  976. for a variable-length packed RecordID.
  977. */
  978. struct ProtoPackedRecordID {
  979.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  980.                                                                 /* Followed by data */
  981. };
  982. typedef struct ProtoPackedRecordID ProtoPackedRecordID;
  983.  
  984. typedef PackedRecordID *PackedRecordIDPtr;
  985. typedef ProtoPackedRecordID *ProtoPackedRecordIDPtr;
  986. /*
  987. Copy PackedRecordID pRID1 to PackedRecordID pRID2.  pRID2 must already contain
  988. pointers to structures large enough to hold copies of the corresponding
  989. fields from pRID1.  A memFull error will be returned if that is not the case.
  990. pRID2Length is the number of bytes that can be put into pRID2, not counting the
  991. packed RecordID header.
  992. */
  993. extern pascal OSErr OCECopyPackedRecordID(const PackedRecordID *pRID1, const PackedRecordID *pRID2, unsigned short pRID2Length)
  994.  THREEWORDINLINE(0x303C, 0x0306, 0xAA5C);
  995.  
  996. /*
  997. Create a RecordID from a PackedRecordID.
  998. NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO THE PACKED STRUCT - DON'T DELETE
  999. OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED WITH THE UNPACKED STRUCT AS WELL
  1000. */
  1001. extern pascal void OCEUnpackRecordID(const PackedRecordID *pRID, RecordID *rid)
  1002.  THREEWORDINLINE(0x303C, 0x0332, 0xAA5C);
  1003.  
  1004. /*
  1005. Create a PackedRecordID from a RecordID.  pRID must be large enough to contain
  1006. the packed RecordID.  A memFull error will be returned if that is not the case.
  1007. packedRecordIDLength is the number of bytes that can be put into pRID, not
  1008. counting the header.
  1009. */
  1010. extern pascal OSErr OCEPackRecordID(const RecordID *rid, PackedRecordID *pRID, unsigned short packedRecordIDLength)
  1011.  THREEWORDINLINE(0x303C, 0x0326, 0xAA5C);
  1012.  
  1013. /*
  1014. Compute the number of bytes of memory needed to hold a RecordID when packed. This
  1015. length includes the length of the length field of PackedRecordID, so it
  1016. is safe to do a NewPtr (OCEPackedRecordIDSize(...)).
  1017. */
  1018. extern pascal unsigned short OCEPackedRecordIDSize(const RecordID *rid)
  1019.  THREEWORDINLINE(0x303C, 0x032B, 0xAA5C);
  1020.  
  1021. /*
  1022. Check the equality of two packed RIDs.
  1023. */
  1024. extern pascal Boolean OCEEqualPackedRecordID(const PackedRecordID *pRID1, const PackedRecordID *pRID2)
  1025.  THREEWORDINLINE(0x303C, 0x0312, 0xAA5C);
  1026.  
  1027. /* OCEValidPackedRecordID checks the validity of a packed record ID. */
  1028. extern pascal Boolean OCEValidPackedRecordID(const PackedRecordID *pRID)
  1029.  THREEWORDINLINE(0x303C, 0x0335, 0xAA5C);
  1030.  
  1031. /**** DSSpec ****/
  1032. struct DSSpec {
  1033.     RecordID *                        entitySpecifier;
  1034.     OSType                             extensionType;
  1035.     unsigned short                     extensionSize;
  1036.     void *                            extensionValue;
  1037. };
  1038. typedef struct DSSpec DSSpec;
  1039.  
  1040. typedef DSSpec *DSSpecPtr;
  1041. /*
  1042. struct PackedDSSpec is NOT a maximum-sized structure.  Allocate one of
  1043. these and it will hold any valid packed RecordID, but not necessarily any additional
  1044. data.
  1045. */
  1046.  
  1047. enum {
  1048.     kPackedDSSpecMaxBytes        = (sizeof(PackedRecordID) + sizeof(OSType) + sizeof(UInt16))
  1049. };
  1050.  
  1051. struct PackedDSSpec {
  1052.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  1053.     Byte                             data[1832];
  1054. };
  1055. typedef struct PackedDSSpec PackedDSSpec;
  1056.  
  1057. typedef PackedDSSpec *PackedDSSpecPtr;
  1058. typedef PackedDSSpecPtr *PackedDSSpecHandle;
  1059. /*
  1060. struct ProtoPackedDSSpec is a minimum-sized structure.  Use this
  1061. for a variable-length packed DSSpec.
  1062. */
  1063. struct ProtoPackedDSSpec {
  1064.     unsigned short                     dataLength;                    /* dataLength excludes the space for the dataLength field */
  1065.                                                                 /* Followed by data */
  1066. };
  1067. typedef struct ProtoPackedDSSpec ProtoPackedDSSpec;
  1068.  
  1069. typedef ProtoPackedDSSpec *ProtoPackedDSSpecPtr;
  1070. /*
  1071. Copy PackedDSSpec pdss1 to PackedDSSpec pdss2.  pdss2 must already contain
  1072. pointers to structures large enough to hold copies of the corresponding
  1073. fields from pdss1.  A memFull error will be returned if that is not the case.
  1074. pdss2Length is the number of bytes that can be put into pdss2, not counting the
  1075. packed DSSpec header.
  1076. */
  1077. extern pascal OSErr OCECopyPackedDSSpec(const PackedDSSpec *pdss1, const PackedDSSpec *pdss2, unsigned short pdss2Length)
  1078.  THREEWORDINLINE(0x303C, 0x0303, 0xAA5C);
  1079.  
  1080. /*
  1081. Create a DSSpec from a PackedDSSpec.
  1082. NOTE THAT THE UNPACKED STRUCT CONTAINS POINTERS INTO THE PACKED STRUCT - DON'T DELETE
  1083. OR REUSE THE PACKED STRUCT UNTIL YOU ARE FINISHED WITH THE UNPACKED STRUCT AS WELL.
  1084. A pointer to the extension is returned in dss->extensionValue, and the length of that
  1085. extension is returned in dss->extensionSize.  If there is no extension, dss->extensionValue will
  1086. be set to nil.  This routine will unpack the RecordID (if any) into rid, unpack the rest
  1087. into dss, and set dss->entitySpecifier to rid.
  1088. */
  1089. extern pascal void OCEUnpackDSSpec(const PackedDSSpec *pdss, DSSpec *dss, RecordID *rid)
  1090.  THREEWORDINLINE(0x303C, 0x032F, 0xAA5C);
  1091.  
  1092. /*
  1093. Create a PackedDSSpec from a DSSpec.  pdss must be large enough to
  1094. contain the packed RecordID and any extension.  A memFull error will be returned if that
  1095. is not the case.  pdssLength is the number of bytes that can be put into pdss,
  1096. not counting the header.
  1097. */
  1098. extern pascal OSErr OCEPackDSSpec(const DSSpec *dss, PackedDSSpec *pdss, unsigned short pdssLength)
  1099.  THREEWORDINLINE(0x303C, 0x0322, 0xAA5C);
  1100.  
  1101. /*
  1102. Compute the number of bytes of memory needed to hold a DSSpec when packed. This
  1103. length includes the length of the length field of PackedDSSpec, so it
  1104. is safe to do a NewPtr (OCEPackedDSSpecSize(...)).
  1105. */
  1106. extern pascal unsigned short OCEPackedDSSpecSize(const DSSpec *dss)
  1107.  THREEWORDINLINE(0x303C, 0x0327, 0xAA5C);
  1108.  
  1109. /*
  1110.     Check the equality of two DSSpecs.  This compares all fields, even the
  1111. extension (unless extensionSize == 0).  The extensions are compared in a case-insensitive and
  1112. diacrit-insensitive manner. 
  1113. */
  1114. extern pascal Boolean OCEEqualDSSpec(const DSSpec *pdss1, const DSSpec *pdss2)
  1115.  THREEWORDINLINE(0x303C, 0x030E, 0xAA5C);
  1116.  
  1117. /*
  1118.     Check the equality of two PackedDSSpecs.  This compares all fields, even the
  1119. extension (unless extensionSize == 0).  The extensions are compared in a case-insensitive and
  1120. diacrit-insensitive manner. 
  1121. */
  1122. extern pascal Boolean OCEEqualPackedDSSpec(const PackedDSSpec *pdss1, const PackedDSSpec *pdss2)
  1123.  THREEWORDINLINE(0x303C, 0x0310, 0xAA5C);
  1124.  
  1125. /*
  1126. Check the validity of a PackedDSSpec.  If extensionType is
  1127. 'entn', pdss must contain a valid entitySpecifier.  For all other extensionTypes, a nil
  1128. entitySpecifier is valid, but if non-nil, it will be checked for validity.  No check
  1129. is made on the extension.
  1130. */
  1131. extern pascal Boolean OCEValidPackedDSSpec(const PackedDSSpec *pdss)
  1132.  THREEWORDINLINE(0x303C, 0x0333, 0xAA5C);
  1133.  
  1134. /*
  1135. Return info about a DSSpec.  This routine does not check validity.  If the
  1136. DSSpec has no extension, we determine whether it represents the root of all
  1137. catalogs, a single catalog, a DNode, or a Record.  Else it is invalid.
  1138. If the DSSpec has an extension, we simply return the extension type.
  1139. */
  1140. extern pascal OSType OCEGetDSSpecInfo(const DSSpec *spec)
  1141.  THREEWORDINLINE(0x303C, 0x0319, 0xAA5C);
  1142.  
  1143. /* OCEGetExtensionType returns the extensionType imbedded in the PackedDSSpec. */
  1144. extern pascal OSType OCEGetExtensionType(const PackedDSSpec *pdss)
  1145.  THREEWORDINLINE(0x303C, 0x031C, 0xAA5C);
  1146.  
  1147. /*
  1148. OCEStreamPackedDSSpec streams (flattens) a catalog object a little at a time by
  1149. calling the DSSpecStreamer routine that you provide.
  1150. */
  1151. typedef pascal OSErr (*DSSpecStreamerProcPtr)(void *buffer, unsigned long count, Boolean eof, long userData);
  1152.  
  1153. #if GENERATINGCFM
  1154. typedef UniversalProcPtr DSSpecStreamerUPP;
  1155. #else
  1156. typedef DSSpecStreamerProcPtr DSSpecStreamerUPP;
  1157. #endif
  1158.  
  1159. enum {
  1160.     uppDSSpecStreamerProcInfo = kPascalStackBased
  1161.          | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
  1162.          | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(void *)))
  1163.          | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(unsigned long)))
  1164.          | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(Boolean)))
  1165.          | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(long)))
  1166. };
  1167.  
  1168. #if GENERATINGCFM
  1169. #define NewDSSpecStreamerProc(userRoutine)        \
  1170.         (DSSpecStreamerUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppDSSpecStreamerProcInfo, GetCurrentArchitecture())
  1171. #else
  1172. #define NewDSSpecStreamerProc(userRoutine)        \
  1173.         ((DSSpecStreamerUPP) (userRoutine))
  1174. #endif
  1175.  
  1176. #if GENERATINGCFM
  1177. #define CallDSSpecStreamerProc(userRoutine, buffer, count, eof, userData)        \
  1178.         CallUniversalProc((UniversalProcPtr)(userRoutine), uppDSSpecStreamerProcInfo, (buffer), (count), (eof), (userData))
  1179. #else
  1180. #define CallDSSpecStreamerProc(userRoutine, buffer, count, eof, userData)        \
  1181.         (*(userRoutine))((buffer), (count), (eof), (userData))
  1182. #endif
  1183. typedef DSSpecStreamerUPP DSSpecStreamer;
  1184. extern pascal OSErr OCEStreamPackedDSSpec(const DSSpec *dss, DSSpecStreamer stream, long userData, unsigned long *actualCount)
  1185.  THREEWORDINLINE(0x303C, 0x033D, 0xAA5C);
  1186.  
  1187. /**** AttributeType ****/
  1188. /*
  1189. For the record, an AttributeType is an RString with a smaller maximum size.
  1190. I don't just typedef it to an RString, because I want the definition of the AttributeType
  1191. struct to contain the max length, because I need to include it in the Attribute struct
  1192. below.  But it should be possible to typecast any AttributeType to an RString and use
  1193. all the RString utilities on it.
  1194. */
  1195. struct AttributeType {
  1196.     CharacterSet                     charSet;
  1197.     unsigned short                     dataLength;
  1198.     Byte                             body[32];                    /* always fixed at the max size */
  1199. };
  1200. typedef struct AttributeType AttributeType;
  1201.  
  1202. typedef AttributeType *AttributeTypePtr;
  1203. /* Miscellaneous defines:  (these cannot be made into enums) */
  1204.  
  1205. enum {
  1206.     kMinPackedRStringLength        = (sizeof(ProtoRString))
  1207. };
  1208.  
  1209.  
  1210. enum {
  1211.     kMinPackedRLISize            = (sizeof(ProtoPackedRLI) + sizeof(DirDiscriminator) + sizeof(DNodeNum) + kMinPackedRStringLength + sizeof(ProtoPackedPathName))
  1212. };
  1213.  
  1214. /**** AttributeValue ****/
  1215. /* same class as is used in AppleEvents */
  1216. typedef DescType AttributeTag;
  1217. struct AttributeValue {
  1218.     AttributeTag                     tag;
  1219.     unsigned long                     dataLength;
  1220.     void *                            bytes;
  1221. };
  1222. typedef struct AttributeValue AttributeValue;
  1223.  
  1224. typedef AttributeValue *AttributeValuePtr;
  1225. /**** Attribute ****/
  1226. struct Attribute {
  1227.     AttributeType                     attributeType;
  1228.     AttributeCreationID             cid;
  1229.     AttributeValue                     value;
  1230. };
  1231. typedef struct Attribute Attribute;
  1232.  
  1233. typedef Attribute *AttributePtr;
  1234. extern pascal RString *OCEGetIndRecordType(OCERecordTypeIndex stringIndex)
  1235.  THREEWORDINLINE(0x303C, 0x031B, 0xAA5C);
  1236.  
  1237. extern pascal AttributeType *OCEGetIndAttributeType(OCEAttributeTypeIndex stringIndex)
  1238.  THREEWORDINLINE(0x303C, 0x031A, 0xAA5C);
  1239.  
  1240.  
  1241. enum {
  1242.     _oceTBDispatch                = 0xAA5E
  1243. };
  1244.  
  1245. /*
  1246. ***************************************************************************************
  1247.    PLEASE NOTE! ROUTINES HAVE MOVED TO THIS HEADER!
  1248.  
  1249.    OCESizePackedRecipient, OCEPackRecipient, OCEUnpackRecipient, OCEStreamRecipient,
  1250.    OCEGetRecipientType, and OCESetRecipientType have moved to the OCE header file.
  1251.    The OCEMessaging header includes the OCE header, so no changes to your code are
  1252.    required.
  1253.  
  1254. ***************************************************************************************
  1255. */
  1256. typedef DSSpec OCERecipient;
  1257.  
  1258. enum {
  1259.     kOCESizePackedRecipient        = 830,
  1260.     kOCEPackRecipient            = 831,
  1261.     kOCEUnpackRecipient            = 832,
  1262.     kOCEStreamRecipient            = 833,
  1263.     kOCEGetRecipientType        = 834,
  1264.     kOCESetRecipientType        = 835
  1265. };
  1266.  
  1267. /*
  1268. Compute the space that a OCERecipient would take if it were in packed
  1269. form.  [Note: does NOT even pad extensionSize, so you may get an odd #back out]
  1270. Safe to pass dereferenced handle(s).
  1271. */
  1272. extern pascal unsigned short OCESizePackedRecipient(const OCERecipient *rcpt)
  1273.  THREEWORDINLINE(0x303C, 0x033E, 0xAA5C);
  1274.  
  1275. /*
  1276. Take an OCERecipient (scatter) and (gather) stream into the specified
  1277. buffer.  It is assumed that there is sufficient space in the buffer (that is
  1278. OCESizePackedRecipient).  Safe to pass dereferenced handle(s).
  1279. */
  1280. extern pascal unsigned short OCEPackRecipient(const OCERecipient *rcpt, void *buffer)
  1281.  THREEWORDINLINE(0x303C, 0x033F, 0xAA5C);
  1282.  
  1283. /*
  1284. Take a packed OCERecipient and cast a the OCERecipient frame over it. Returns
  1285. amBadDestId if it doesn't look like an OCERecipient. Safe to pass dereferenced
  1286. handle(s).
  1287. */
  1288. extern pascal OSErr OCEUnpackRecipient(const void *buffer, OCERecipient *rcpt, RecordID *entitySpecifier)
  1289.  THREEWORDINLINE(0x303C, 0x0340, 0xAA5C);
  1290.  
  1291. /*
  1292. Take an OCERecipient (scatter) and (gather) stream using the specified
  1293. function.  Safe to pass dereferenced handle(s).  If streamer function returns
  1294. OCEError OCEStreamRecipient stops execution and passes the error back to the caller
  1295. */
  1296. typedef pascal OSErr (*OCERecipientStreamerProcPtr)(void *buffer, unsigned long count, Boolean eof, long userData);
  1297.  
  1298. #if GENERATINGCFM
  1299. typedef UniversalProcPtr OCERecipientStreamerUPP;
  1300. #else
  1301. typedef OCERecipientStreamerProcPtr OCERecipientStreamerUPP;
  1302. #endif
  1303.  
  1304. enum {
  1305.     uppOCERecipientStreamerProcInfo = kPascalStackBased
  1306.          | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
  1307.          | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(void *)))
  1308.          | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(unsigned long)))
  1309.          | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(Boolean)))
  1310.          | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(long)))
  1311. };
  1312.  
  1313. #if GENERATINGCFM
  1314. #define NewOCERecipientStreamerProc(userRoutine)        \
  1315.         (OCERecipientStreamerUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), uppOCERecipientStreamerProcInfo, GetCurrentArchitecture())
  1316. #else
  1317. #define NewOCERecipientStreamerProc(userRoutine)        \
  1318.         ((OCERecipientStreamerUPP) (userRoutine))
  1319. #endif
  1320.  
  1321. #if GENERATINGCFM
  1322. #define CallOCERecipientStreamerProc(userRoutine, buffer, count, eof, userData)        \
  1323.         CallUniversalProc((UniversalProcPtr)(userRoutine), uppOCERecipientStreamerProcInfo, (buffer), (count), (eof), (userData))
  1324. #else
  1325. #define CallOCERecipientStreamerProc(userRoutine, buffer, count, eof, userData)        \
  1326.         (*(userRoutine))((buffer), (count), (eof), (userData))
  1327. #endif
  1328. typedef OCERecipientStreamerUPP OCERecipientStreamer;
  1329. extern pascal OSErr OCEStreamRecipient(const OCERecipient *rcpt, OCERecipientStreamer stream, long userData, unsigned long *actualCount)
  1330.  THREEWORDINLINE(0x303C, 0x0341, 0xAA5C);
  1331.  
  1332. /* Get the OCERecipient's extensionType. Safe to pass dereferenced handle(s).*/
  1333. extern pascal OSType OCEGetRecipientType(const CreationID *cid)
  1334.  THREEWORDINLINE(0x303C, 0x0342, 0xAA5C);
  1335.  
  1336. /*
  1337. Set the OCERecipient's extensionType in the specified cid.  (Note: we do NOT
  1338. check for a nil pointer).  If the extensionType is 'entn', the cid is assumed
  1339. to be "valid" and is not touched.  Note: to properly handle non 'entn''s this
  1340. routine must and will zero the high long (source) of the cid! Safe to pass
  1341. dereferenced handle(s).
  1342. */
  1343. extern pascal void OCESetRecipientType(OSType extensionType, CreationID *cid)
  1344.  THREEWORDINLINE(0x303C, 0x0343, 0xAA5C);
  1345.  
  1346. /*
  1347. ***************************************************************************************
  1348.    PLEASE NOTE! ROUTINES HAVE MOVED TO THIS HEADER!
  1349.  
  1350.    OCEGetAccessControlDSSpec and its corresponding data type and constants have
  1351.    moved to the OCE header from OCEAuthDir. The OCEAuthDir header includes the OCE
  1352.    header, so no changes to your code are required.
  1353.    
  1354. ***************************************************************************************
  1355. */
  1356. /* access categories bit numbers */
  1357.  
  1358. enum {
  1359.     kThisRecordOwnerBit            = 0,
  1360.     kFriendsBit                    = 1,
  1361.     kAuthenticatedInDNodeBit    = 2,
  1362.     kAuthenticatedInDirectoryBit = 3,
  1363.     kGuestBit                    = 4,
  1364.     kMeBit                        = 5
  1365. };
  1366.  
  1367. /* Values of CategoryMask */
  1368.  
  1369. enum {
  1370.     kThisRecordOwnerMask        = (1L << kThisRecordOwnerBit),
  1371.     kFriendsMask                = (1L << kFriendsBit),
  1372.     kAuthenticatedInDNodeMask    = (1L << kAuthenticatedInDNodeBit),
  1373.     kAuthenticatedInDirectoryMask = (1L << kAuthenticatedInDirectoryBit),
  1374.     kGuestMask                    = (1L << kGuestBit),
  1375.     kMeMask                        = (1L << kMeBit)
  1376. };
  1377.  
  1378. typedef unsigned long CategoryMask;
  1379. /*
  1380. pass kThisRecordOwnerMask, kFriendsMask, kAuthenticatedInDNodeMask, kAuthenticatedInDirectoryMask,
  1381. kGuestMask, or kMeMask to this routine, and it will return a pointer to a
  1382. DSSpec that can be used in the Get or Set Access Controls calls.
  1383. */
  1384. extern pascal DSSpec *OCEGetAccessControlDSSpec(CategoryMask categoryBitMask)
  1385.  THREEWORDINLINE(0x303C, 0x0345, 0xAA5C);
  1386.  
  1387. #endif
  1388. #endif /* REZ */
  1389.  
  1390. #if PRAGMA_ALIGN_SUPPORTED
  1391. #pragma options align=reset
  1392. #endif
  1393.  
  1394. #if PRAGMA_IMPORT_SUPPORTED
  1395. #pragma import off
  1396. #endif
  1397.  
  1398. #ifdef __cplusplus
  1399. }
  1400. #endif
  1401.  
  1402. #endif /* __OCE__ */
  1403.  
  1404.